NetRender(C) Remote Gathering Agent (NRRGA)
The NetRender(C) Remote Gathering Agent (NRRGA) is a Lightwave(C) plugin which provides Lightwave 5.5 users with the ability to export a Lightwave scene (and its render relevant files) and upload those files through secure Internet file transfers to a NetRender enabled web site.
NRRGA Installation:
- Copy the nrrga.p and laymon.p plugin files to the Lightwave plugins/layout directory (e.g., C:\Newtek\Plugins\Layout)
- Add the two plugin files via Layout's Options -> General Options interface just as you would any plugin
- Install the FileDrive Client (version 1.5 or later) by running the iFileDrive.exe FileDrive self-install program.
NOTE: The FileDrive client should be part of this distribution but may also be obtained from http://www.assetfactory.com.
a) Preferences -> Proxy - proxy settings you may have at your facility
b) Preferences -> Security - Enable security (file transfer encryption)
c) Preferences -> General - Launch FileDrive on system startup (recommended)
NOTE: You may also configure additional settings, such as entering your email address or enabling Netscape FTP URL intercepts, etc.
NRRGA Usage:
To perform scene export:
- Load the scene. The scene should load without errors. Fix any load errors (e.g., "Object not found") prior to continuing. Otherwise, the NRRGA plugin may propagate the same errors and/or fail.
NOTE: It is recommended you save the objects, scene, etc., as needed. and then reload the scene.
- Run the NRRGA plugin (Options -> Generic Plugins ->AF_NetRender)
- Click "Select Export Directory" and select a directory for scene export.
This directory will become a "Content Directory" (similar to C:\NewTek ). It is strongly recommended to create a new, or use an empty, directory such as C:\scene_exports\content\. NRRGA will then create, using the above example, C:\scene_exports\content\images, C:\scene_exports\content\objects, C:\scene_exports\content\scenes, etc.
COMMENT: Mapped network drives are fine but some latency in processing may occur depending on your network.
The NRRGA plugin will create the export directory structure under the selected 'Export Content Directory' and process the scene's files.
Scene Export and NetRender processing:
- Follow the steps listed above for scene export.
- Click to enable the NetRender option on the plugin interface - the NetRender fields should become enabled (editable).
- Run FileDrive Client application prior to running the plugin.
Otherwise, the FileDrive application may perform some ... weird operations and upload processing may not behave as desired.
You will also wish to verify FileDrive's Edit->Preferences->Security->Enable Security setting is enabled.
- The NRRGA plugin will process the scene export as usual and then attempt to upload the scene files to the NetRender site for Rendering. This is achieved by first contacting the NetRender site (using SSL encryption) and negotiating a new job submission - this may take a few moments. If login attempts are successful, the plugin then automatically adds the scene files (those in the exported content directory) to the FileDrive Client upload queue.
REMEMBER, YOU MUST ENABLE SECURITY IN FILEDRIVE YOUSELF!!! -the plugin will not do this for you.
- The NRRGA plugin will display an Information dialog notifying you of plugin completion.
BE AWARE: FileDrive will probably continue to upload files following plugin completion. This is normal and varies depending on Internet connection speed and size of the scene. However, once the plugin exits and returns control to Layout, regardless of continued FileDrive activity, you may resume editing the ORIGINAL scene, unload the scene, or even exit Lightwave altogether .
NOTE: Please do not attempt to edit the exported files until FileDrive completes it's transfer, otherwise, unpredictable image rendering may result.
NRRGA Processing Activity:
NRRGA actions upon the scene's files are limited to the following:
Scene files are generated in the following order: Images, Objects, and finally the Scene. The new, exported, scenename is becomes nr_scenename.
NOTE: ALL images are located under the export Images directory, ALL objects under the Objects directory. The original directory structure will not be preserved (see also Name Conflict Handling below for additional information).
- NRRGA generates a few log files: "plugins.log", "mod_hist.log", and "err_info.log".
Plugins.log lists plugins, if any, used by the scene file (see Comments:Plugins).
Mod_hist.log file contains a listing of all scene objects, images, clips, etc. referenced within the scene. It also indicates the source file used in the original scene and the corresponding destination file generated.
Err_info.log is always generated and contains additional information on any errors the NRRGA plugin experienced during execution. In cases where no errors were recorded, this log file contains a message stating this to be the case.
- Original files are UNMODIFIED and remain in original locations. You may review the mod_hist.log file for a more detailed list of which source files were used and where they were exported.
- A scene file is generated based upon CURRENT LAYOUT SETTINGS - NOT necessarily the settings originally loaded with the scene. The generated scene file (prefixed by nr_ to create nr_scenename) is modified to contain the new references to objects, images, etc., relative to the selected 'Export Content Directory' path.
- Exported object files are modified to replace file references with the new relative path locations of images, sequences and Flyer clips. It will overwrite existing files (without asking) since reuse of an export directory is a viable option - NRRGA believes you know what you're doing.
- NOTE
: All path references become relative to the selected 'Export Content Directory' path and, assuming proper NRRGA operation, NO absolute path names should exist in the generated scene file nor it's object files.
For example, you may now move the export content directory to another location, or machine, without further modifications or having to manually correct for 'Object not found' messages. In fact, such messages generally indicate Layout's Content Directory setting is incorrect.
The exception to this rule, of course, are plugins. A Lightwave Layout installation on another machine will require the same installed plugins for proper rendering. In addition, any plugin related support files (e.g., Particle Storm .PSM files), must be manually copied to the export directory (if desired).
Comments:
Name Conflict Handling:
- Name conflicts result when two files of the same name, located in different directory locations, and referenced in a given scene.
For example, C:\this\that\image.iff and G:\some\other\image.iff. Normally, filenames would be left alone. However, when such conflicts occur, the NetRender Remote Gathering Agent renames the offending filenames by making [the second] image.iff, 1_image.iff, etc. This processing holds true for LW objects, images, and Flyer clips.
NOTE: Name conflict renaming standards (prefixing #_) allows for image sequence renaming (which are really just individual images) to remain compatible with sequence naming procedures. For example, name001.iff, name002.iff, name003.iff, in the case of a duplicated name sequence, would become 1_name001.iff, 1_name001.iff, 1_name001.iff. Proper scene references to the give sequence are replaced appropriately.
Plugins:
- The AF_NetRender plugin will identify plugins used by the current scene. A list of plugins used in the scene are logged to the file <export_dir>/logs/plugins.log.
- Plugin support files (such as a Particle Storm .PSM file) ARE NOT identified (nor copied, nor uploaded, etc.).
Implementation of plugin support for every possible plugin, now and in the future, is beyond any reasonable scope. Therefore, required plugin support files will need to be manually copied to a location under the exported content directory or, if using the NetRender service, manually added to the upload FileDrive upload queue. Manually adding files to the upload queue can be performed by either:
1) WWW browsing your NetRender account, selecting 'View Jobs', clicking on the upload hyperlink on the specified job number, and adding the file(s) to the FileDrive client, or
2) opening the <export_path>/logs/joblog.html file and clicking on the indicated upload hyperlink.
NOTE: The joblog.html file is only generated if you selected the NetRender option on the plugin interface prior to NRRGA processing.
NOTE: While plugins in use by the scene are identified, the plugin .p files ARE NOT included in the export NOR any subsequent uploads. This is due to several important issues:
First, plugins are independent of individual scenes. Modification of the LW.cfg file to indicate an "exported" plugin.p file simply does not make sense. Instead, loading the exported scene will use the [already installed] Lightwave plugin designated in LW.cfg - just as one would expect.
Second, default plugins are already installed on the NetRender renderfarm system.
Finally, and most important, non-default plugins are usually either purchased or custom built "in-house" by your facility. Consequently, licensing, and other legal, restrictions prohibit automatically grabbing and uploading (a.k.a., "stealing") the .p files. Rather, this is the purpose of the plugins.log file generated during NRRGA execution. The plugins.log file allows you, and a NetRender system engineer, to readily identify needed plugins, determine potential problems and assist in plugin installation. NetRender system engineers will [happily:)] work with you on a case by case basis to resolve such issues. The NetRender service may need to obtain and install the plugin if not already available.
Trouble Shooting:
- NetRender/FileDrive upload problems
Failure to connect for NetRender file submission could result from a number of possibilities. If errors continue to arise and you feel your configuration is correct, please contact Asset Factory, Inc. (www.assetfactory.com) technical support for additional assistance.
- ERROR: NRRGA was unable to locate a NetRender server
1) You are possibly located behind a firewall or Internet proxy server. Contact your Network Administrator for proper proxy settings and verify the settings are correct under FileDrive's Edit->Preferences->Proxy Server
2) Verify the you did not include http:// or https:// in the 'NetRender URL' field.
3) The NRRGA plugin was unable to log into your NetRender account. Verify your user name (NetRender account login ID) and password are correct
NRRGA Features:
Lightwave Scene Export:
- Gathering of LWS, LWO, and related images, flyer clips, etc. required for scene rendering.
- Creation of a scenes, images, and objects directory under a user designated "Export Content Directory" location.
- Parsing of LWS files to identify and revise file references to correspond with export content directory.
- Parsing of Lightwave object files to identify and revise file references to correspond with user selected 'Export Content Directory'.
- Name conflict handling
- Gathering of files located outside of "normal" content directory (i.e. C:\object\in\some\random\directory\anObject.lwo)
- Original scene, and related, files remain in original locations and are unmodified
NetRender Security Features:
- SSL secure HTML for NetRender account access and job submission negotiation
- Secure, reliable FTP via FileDrive(R) Encrypted File Transfer protocols
- Please see the documentation and license agreement provided with the FileDrive(R) client or visit http://www.assetfactory.com for additional information
Outstanding Issues:
Known Issues:
- NetRender Remote Gathering Agent (NRRGA) does not support UNC path names. No plans exist to resolve this unless there is a large demand for it.
ToDo List:
- Encrypted NetRender password text field
- Software ports to NT Alpha, Solaris, and IRIX (following initial alpha release testing)
DISCLAIMER:
While no one can guarantee 100% absolute security and privacy for activities across the WWW Internet, The NetRender service makes use of may of today's latest technology such as secure FTP, and SSL encrypted communication. Asset Factory, Inc. and its development partners have made reasonable efforts to ensure confidentiality, privacy, and security within the NetRender service. The users of this software and/or Asset Factory, Inc. services do so at their own risk and understand, accept and assume any, and all, liability and responsibility. Asset Factory, Inc., et. al. accept no responsibility for losses which may result from use.
NetRender is a registered trademark of Asset Factory, Inc., Mountain View, CA. Lightwave is a registered trademark of NewTek, Inc., San Francisco, CA. FileDrive is a registered trademark of, Differential, Inc., Cupertino, CA. All other references are the trademarks of their respective owners.
Copyright(C) 1997,1998